Amiga Tools 2/Amiga Tools 2.iso/tex/macros/source/contrib/xypic/install.textures

Text File | 1995-03-10 | 19.3 KB | 471 lines

  ===============================================================
  INSTALLING THE XY-pic DIAGRAM TYPESETTING MACROS ON A MACINTOSH
  ===============================================================

This file assumes that you have downloaded the `xy212mac.sit.hqx'
file and have decoded this and have expanded and extracted all files
and folders from the resulting compressed archive.

It also assumes that you have the TeX application called Texturesª,
from Blue Sky Research, Portland, Oregon (version 1.4 or later).


The main difference between Texturesª and other TeX implementations
is the way in which fonts are handled. Here we deal with Macintosh
font suitcases containing bitmap versions of the special fonts that
XY-pic uses, as well as a suitcase containing the font metrics.

For users of OzTeX a folder called `for OzTeX only' contains .pk fonts,
.tfm files and some configuration files. The file `INSTALL.OzTeX'
explains how to install these.

For any other implementations of TeX on the Macintosh, there may be
sufficient files here to install XY-pic. If not then obtain the full
XY-pic distribution from one of the usual ftp sites:
    ftp.mpce.mq.edu.au  in the  /pub/maths/TeX  directory;
    ftp.diku.dk          in the  /diku/users/kris/TeX  directory;
    CTAN in the   tex-archive/macros/generic/diagrams/xypic  directory;
      e.g. at  ftp.shsu.edu, ftp.tex.ac.uk  and  ftp.dante.de.

(If this is still insufficient, then the author would like to know
what other resources are required and why.
Contact him by email at the address given below.)


From version 2.10, the source files are NOT included with the
Macintosh Distribution, as doing this would add almost 1 MByte
to its overall size. Obtain them from the sites listed above.


I'll also assume that you use a 300 dots per inch laser printer
(like the Apple laserwriter or HP laserjet).

Contents:

  -0- Simple Installation, for experienced users
  -1- Copyleft
  -2- Updating from version 2.6 (and earlier) or 2.7 -- 2.11
  -3- Overview of files and where they should be installed
  -4- Manuals and Sources
  -5- Memory Requirements
  -6- Bugs & comments

----------------------------------------------------------------------
  -0- SIMPLE INSTALLATION, for EXPERIENCED USERS
----------------------------------------------------------------------

If you have never used XY-pic before and are experienced as a user
of Texturesª, then the following instructions should be sufficient
to get XY-pic installed.

You should have extracted two folders called `for TeX inputs folder'
and `for TeX fonts folder' from the Stuffit archive.

Simply copy the contents of these folders to the places indicated by
their names; namely the font suitcases go into the `TeX Fonts` folder,
while the `xy*.tex` source code files go into the `TeX inputs` folder.


If these instructions do not make sense to you, or you get any warning
messages when you try to carry out these steps, then...

    STOP immediately!

... read the rest of this file, to learn more about XY-pic, what all
the files contain and how they should be installed on your Macintosh.

If you had no trouble with this installation, then... enjoy XY-pic!
Please do us the courtesy of reading the rest of this file anyway.
In particular please respect the following Copyright message, making
sure that any copies that you may distribute are complete, so that
others can equally enjoy XY-pic (... and so that we do not get irate
messages about missing features).

----------------------------------------------------------------------
  -1- COPYLEFT
----------------------------------------------------------------------

This distribution of the XY-pic package is distributed with copyleft:

  Copyright (c) 1991-1994    Kristoffer H. Rose  <[e-mail]>
  Copyright (c) 1994         Ross Moore  <[e-mail]>

  The XY-pic package is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The XY-pic package is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this package; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

What this means is that if you install XY-pic then you should (1) make
sure that the file COPYING is accessible to the users, and (2) be
prepared to provide XY-pic (including sources) to any of your users
that request it (you may charge a fee for this if you are so inclined).

----------------------------------------------------------------------
  -2- UPDATING FROM VERSION 2.6 (AND EARLIER) OR 2.7 -- 2.11
----------------------------------------------------------------------

XY-pic version 2.7 was almost a complete rewrite of XY-pic. The update
to version 2.8 fixed numerous small bugs and added PostScript \special
commands that could be used instead of the XY-pic fonts.
In version 2.9 the PostScript functionality was extended to include
effects such as rotation and scaling of diagrams and text, variable
line thickness and colour support. There were also improvements in many
other aspects of the way XY-pic works.

A Macintosh version of 2.9 was never released, as some of the claimed
effects did not actually work. These bugs were fixed for version 2.10.

Version 2.11 included the `Graph Combinator' feature which provides
a simplified interface for many common classes of diagrams.
Also some minor bugs were fixed, both in code and documentation.

This version 2.12 is necessary to accommodate a change to AMS-LaTeX
which otherwise seriously conflicts with internal structure of XY-pic.
A new `Polygon' feature has been added and many subtle bugs fixed.
Also much of the `curve' code has been improved, especially for
`curved arrows'.


Also, version 2.12 provides for a new font for arrow-tips, in the style
of those arrowheads that appear in the Computer Modern fonts.
Fonts   xycmat10  and  xycmbt10  have always been included in the font
suitcases (since version 2.6) but not used due to errors in the metrics.
This has now been rectified --- this means that the font metric file
`XY-pic metrics'  MUST BE REPLACED with the latest version --- having
modification date: 20 August 1994 --- but the fonts are unchanged.


XY-pic version 3.1 is due before the end of 1994.
Among the new features will be one for typesetting `crossing strings',
in particular elegant representations of `knots'. A feature for drawing
`chemical structures' may also be ready.


If you already have version 2.7 (or later) installed then:

* Copy the file:  `XY-pic metrics' , to be found in the folder called
 `for TeX fonts folder', into your `TeX Fonts' folder.

+ The file `XY-pic fonts' contains no new fonts, so need not be updated.

+ With version 7.1+ of the Macintosh operating system, you can place
  font suitcases in the Fonts subfolder of the system folder.
  However the `XY-pic metrics' suitcase MUST be in the `TeX Fonts' folder.

+ Extra font sizes are available in a separate archive called `xymacxf.sit',
  see below for more details. These can be installed locally, if desired.
  Alternatively the extra sizes may be installed on a file-server;
  then place an `alias' (requires system 7.0+) to them within the `TeX Fonts'
  folder --- the server will mount when Textures is launched.


* Copy the contents of the `for TeX inputs folder' into the
  obvious place, i.e. the `TeX Inputs' folder, allowing these files to
  replace the existing ones of the same name.

+ With the system-7 operating system, you can place the files/folders
   elsewhere, and place aliases to them within the `TeX Inputs' folder.



If you already have version 2.6 (or some earlier version) installed then
note the following:

* All the fonts have been redone AND renamed.  Thus installing the new
  version will not break any typeset files you already have that use
  the old fonts. However if you intend to keep the old version on your
  system then you should rename the font and metrics suitcases to
  `XY-pic fonts.old' and `XY-pic metrics.old'.

* The distribution contains new versions of the files `xypic.tex' and
  `xypic.sty' that load XY-pic 2.12 in a special compatibility mode.
  Thus re-TeX'ing your source documents will create typeset versions
  using the new fonts. If you wish to keep the old `xypic.tex' and
  `xypic.sty' then you should rename them before installation.

* There are a few points where the backwards compatibility is not
  perfect -- these are noted in the documentation.


----------------------------------------------------------------------
  -3- OVERVIEW OF FILES AND WHERE THEY SHOULD BE INSTALLED
----------------------------------------------------------------------

You need to install the following groups of files:

AVAILABILITY: These three files contain general information and should
be installed in a publicly readable place (if necessary you may give
them an `xy' prefix):

  TRAILER                         summary of features and availability
  INSTALL.Textures         how to install XY-pic for Textures (this file)
  INSTALL.other         how to install XY-pic on other systems
  COPYING                         GNU General Public License

MACROS: This group contains TeX/LaTeX macro files that must be
installed in a place which TeX/LaTeX will search (this is normally
the `TeX Inputs' folder):

  xy.tex             XY-pic bootstrap and kernel macros
  xy.sty             LaTeX 2.09 `style option' interface
  xyidioms.tex        format-dependent idioms
  xyall.tex             loads all options

  xytex.ini             Use with VirTeX to dump a format: Plain+XYpic
  xylatex.ini        Use with VirTeX to dump a format: LaTeX+XYpic

  xypic.sty             `Version 2 Compatibility' interface
  xypic.tex             `Version 2 Compatibility' interface
  xyv2.tex              `Version 2 Compatibility' feature

  xycmtip.tex        `Computer Modern Tips' extension
  xycurve.tex        `Curves and Splines' extension
  xycolor.tex        `Colour Support' extension
  xyframe.tex        `Frames and Brackets' extension
  xyline.tex         `Line Styles' extension
  xyrotate.tex       `Rotation and Scaling' extension

  xydummy.tex        Template for new extensions

  xyarrow.tex        `Arrows and Paths' feature
  xymatrix.tex       `Matrix and Diagrams' feature
  xy2cell.tex        `Categorical 2-cells' feature
  xygraph.tex        `Graph Combinator' feature
  xypoly.tex         `Polygon' feature

  xyps.tex             `PostScript Back-end'
  xyps-c.tex         PostScript implementation of xycolor.tex
  xyps-l.tex         PostScript implementation of xyline.tex
  xyps-r.tex         PostScript implementation of xyrotate.tex

  xyps-txt.tex        DVI-driver for `Textures'
  xyps-???.tex        other  DVI-drivers


All the above files have been conveniently placed in a folder called
`for TeX inputs folder'. Simply copy its entire contents into your
`TeX Inputs' folder (after having appropriately dealt with any previous
version, as described above).


POSTSCRIPT DICTIONARY:
Since XY-pic version 2.8 it has been possible to have diagrams drawn using
PostScript commands rather than using the XY-pic fonts. This results in
pictures which are sharper and cleaner. If this feature is to be used
then it helps to also use the header file:

  xy212dict.ps        PostScript Header for XY-pic, version 2.12

It is not necessary to use this header file; furthermore the reference
manual describes how it can be generated if needed from `xyps.tex'.



XY-pic FONTs and METRICs: the two font suitcase files, called `XY-pic fonts'
and `XY-pic metrics', are found in the folder called `for TeX fonts folder'.
Simply move these into the Texturesª `TeX Fonts' folder (after having
appropriately dealt with any previous version, as described above).

When you next launch the Texturesª application the following fonts will
then be available for use in typesetting with the XY-pic macros.

  xydash10     straight line segments at 128 different angles
  xyatip10     top half of an arrow head at 128 different angles
  xybtip10     bottom half of arrow head at 128 different angles
  xybsql10     small quarter turns, for hooks, turns and wavy lines
  xycirc10     eighth-turns at 16 different radii, 8 per radius

These fonts are each provided in four screen sizes: 100% 120% 200% 240%
and in one size for laser-printing at 300dpi: 417%.

If more sizes are required then either:

  a) get the file `xymacxf.sit.hqx' from ftp.mpce.mq.edu.au.
     These expand to give suitcases containing the above sizes plus extra
     laserwriter sizes, corresponding to magsteps 0.5, 1, 2, 3, 4, 5.
     (The xycirc10 is separate since these fonts occupy more space than
     any of the others --- 2.2 MByte!! )

or...

  b) generate extra sizes using Metafont.
       The appropriate xy*.mf source files are included in the sub-directory
        `mfinputs'. This can be obtained from the ftp sites listed above.

    xydash10.mf              kernel font sources
      xyatip10.mf
      xybsql10.mf
     xybtip10.mf
      xycirc10.mf


With the xy*.tex and xy*.sty input files installed in the `TeX Inputs'
folder, and the font suitcases installed in the `TeX Fonts' folder,
you should be ready to use XY-pic to typeset some diagrams.


----------------------------------------------------------------------
  -4- MANUALS and SOURCES
----------------------------------------------------------------------

The `XY-pic User's Guide' and `XY-pic Reference Manual' are provided
with this distribution. They are in the form of pre-typeset Texturesª
documents. These files are Finder-locked and should NOT be re-typeset.
(Indeed it should not be possible to typeset this file without first
removing the safe-guards which have been put in place.)

It is a good idea to test your installation of XY-pic by typesetting
portions from the manuals. Of course you will first have to obtain
these sources from one of the ftp sites listed above, or elsewhere.

Alternatively you can try to typeset the complete manuals, using LaTeX,
from the documents `xyguide.man' and `xyrefer.man' in the directory `src`
where they are located along with all the input and non-standard style
files that they need.
You will need to obtain ALL the files in this directory.
(There is a file named `xy***.doc' for each macro file `xy***.tex'
placed in the `TeX Inputs' folder.)
For this to be successful your Textures application will need a
memory partition of at least 4.5 MBytes.

The normal sequence should be followed: LaTeX, BibTeX, LaTeX, LaTeX
to get all the references and the bibliography typesetting correctly.
These manuals have been checked to work correctly with LaTeX 2.09 and
LaTeX2e.

An alternative way to get the manuals is to download the files called
`xyguide.ps.Z' and `xyrefer.ps.Z' from one of the ftp-sites.
These files were created using the `xyps' PostScript option, so should
produce a higher quality printed output on a PostScript printer of
resolution 300dpi (due to use of bitmapped Computer Modern fonts).



EXTRA files, not provided with the Macintosh distribution:

The following files are provided with the full XY-pic distribution,
for systems that do not use font suitcases, e.g. OzTeX. If you need
them then you should get the complete XY-pic distribution from one
of the ftp sites and follow the installation instructions provided.
 (The file INSTALL.OzTeX contains instuctions specific to OzTeX.)

TEX FONT METRIC files:

  texfonts/xydash10.tfm          kernel TeX font metric files
  texfonts/xyatip10.tfm
  texfonts/xybsql10.tfm
  texfonts/xybtip10.tfm
  texfonts/xycirc10.tfm

BITMAP FONTS: These are for installations that can't use the METAFONT
sources directly but have driver for a 300 dpi laserprinter that
accepts PK bitmap font files.  They should be installed where DVI
previewers and printer drivers will see them (e.g., with un*x, the
`xdvi' program should see them through the XDVIFONTS environment
variable):

  pkfonts/cx300         kernel font bitmaps for the 5 XY-pic fonts
  pkfonts/cx329
  pkfonts/cx360


METAFONT sources are in the `src' folder as described above.

DVI-files:

  xyguide.dvi              User's Guide
  xyrefer.dvi              Reference Manual

These dvi-files are provided primarily for non-Textures users.
Using the `DVI-Tool' application, they can be converted into the
usual form for documents typeset using Texturesª. However this is
not necessary as it has been done already: the `XY-pic User's Guide'
and `XY-pic Reference Manual' described above.

----------------------------------------------------------------------
  -5- MEMORY REQUIREMENTS
----------------------------------------------------------------------

Although many efforts have been made to make XY-pic work quickly and
efficiently, the nature of the diagrams for which it is designed are
sometimes necessarily quite large and consume a significant amount of
TeX's available memory. Do not be surprised if it takes a long time
to typeset a diagram having several rows and columns of entries.

Usually I work with a memory partition set at 4 MBytes, on a Mac IIci
or Macintosh PowerBook. For instance, when typesetting the User's Guide,
using LaTeX-2e and XY-pic, nearly all of this 4 MBytes is required.
The Reference Guide requires even more than this: allowing 8 MByte was
a luxury that I could afford, but I suspect that 4.5 MByte would have
been sufficient. Mind you, although shorter the Users' Guide actually
takes significantly longer to typeset than does the Reference Manual.

----------------------------------------------------------------------
  -6- BUGS & COMMENTS
----------------------------------------------------------------------

This version of XY-pic is numbered 2.12.

* Many quite subtle bugs in earlier code have been identified and fixed.
  In particular curves are much faster and more efficient.

* The powerful `Graph Combinator' feature has been extended.

* A new `Polygon' feature has been added, which greatly assists the
  construction of diagrams in which objects are located in a regular
  way, but not necessarily on a rectangular grid.


The ftp sites ftp.diku.dk and ftp.mpce.mq.edu.au are kept up-to-date
with the latest release, and patches to any serious bugs that users
report.

Reports on any problems that you may encounter will be appreciated,
especially opinions you have on how the usefulness of XY-pic can be
improved. Please report these, concerning XY-pic itself, either to

  Electronic mail (Internet): [e-mail]     [preferred]

  Paper mail:   Kristoffer H. Rose
                DIKU, University of Copenhagen
                Universitetsparken 1
                DK--2100 K{\o}benhavn {\O}
                DENMARK

  Fax [phone]  attn: L.Wiese/K.Rose

or to...

  Electronic mail (Internet): [e-mail]   [preferred]

  Paper mail: Ross Moore
              Mathematics Department,
              Macquarie University
              North Ryde, NSW 2109
              AUSTRALIA

  Fax [phone]  attn: R.Moore

In particular, comments or reports related to the Macintosh distribution
should be sent to Ross Moore, using the address given above.

----------------------------------------------------------------------

This is the end of `INSTALL.Textures'.  We hope you'll enjoy XY-pic !

--
Ross MOORE                               Internet: [e-mail]
Mathematics Dept, Macquarie University, Nth Ryde, NSW 2109,  AUSTRALIA
phone: [phone]      fax: [phone]
--